Cancel a queued job enqueued through the functions API.
using System.Net.Http.Headers;var client = new HttpClient();var request = new HttpRequestMessage{ Method = HttpMethod.Post, RequestUri = new Uri("https://example.com/api/workspace/functions/jobs/example/cancel"),};using (var response = await client.SendAsync(request)){ response.EnsureSuccessStatusCode(); var body = await response.Content.ReadAsStringAsync(); Console.WriteLine(body);}const url = 'https://example.com/api/workspace/functions/jobs/example/cancel';const options = {method: 'POST'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/api/workspace/functions/jobs/example/cancelAuthorizations
Section titled “Authorizations”- None
Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Queued job identifier.
Query Parameters
Section titled “Query Parameters”Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.
Responses
Section titled “Responses”OK
object
Status of a job enqueued through the functions API.
object
Queued job identifier.
Callable key of the enqueued function.
Enqueue timestamp.
Earliest execution timestamp.
Execution attempts so far.
Deduplication key of the job, when supplied.
Correlation identifier of the job, when supplied.
Bounded last execution error summary.
Optional execution timeout captured on the job and preserved across retries.
Whether the job can still be cancelled.
Latest execution of a job enqueued through the functions API.
object
Function run identifier.
Run start timestamp.
Run completion timestamp.
Run duration in milliseconds.
Bounded result summary.
Structured JSON result payload.
object
Bounded error summary.
object
object
object
object
Example
{ "Data": { "Status": 0, "Run": { "Status": 0 } }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Bad Request
object
Status of a job enqueued through the functions API.
object
Queued job identifier.
Callable key of the enqueued function.
Enqueue timestamp.
Earliest execution timestamp.
Execution attempts so far.
Deduplication key of the job, when supplied.
Correlation identifier of the job, when supplied.
Bounded last execution error summary.
Optional execution timeout captured on the job and preserved across retries.
Whether the job can still be cancelled.
Latest execution of a job enqueued through the functions API.
object
Function run identifier.
Run start timestamp.
Run completion timestamp.
Run duration in milliseconds.
Bounded result summary.
Structured JSON result payload.
object
Bounded error summary.
object
object
object
object
Example
{ "Data": { "Status": 0, "Run": { "Status": 0 } }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Forbidden
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Not Found
object
Status of a job enqueued through the functions API.
object
Queued job identifier.
Callable key of the enqueued function.
Enqueue timestamp.
Earliest execution timestamp.
Execution attempts so far.
Deduplication key of the job, when supplied.
Correlation identifier of the job, when supplied.
Bounded last execution error summary.
Optional execution timeout captured on the job and preserved across retries.
Whether the job can still be cancelled.
Latest execution of a job enqueued through the functions API.
object
Function run identifier.
Run start timestamp.
Run completion timestamp.
Run duration in milliseconds.
Bounded result summary.
Structured JSON result payload.
object
Bounded error summary.
object
object
object
object
Example
{ "Data": { "Status": 0, "Run": { "Status": 0 } }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}