GET /v3/jobs/{jobId} Access Denied

Question

Hi,

I'm a Curator and trying to get a list of jobs on the Gallery and cancel any jobs running or in the queue longer that x seconds.  I'm trying to use the GET /v3/jobs/{jobId} endpoint from Swagger, but I am getting an Access Denied error.  Our server version is 2024.1.1.282 Patch: 11

I've also tried GET /v1/jobs/{id} and get the same result.

I found the "Cancel_Manual_Job_v2" workflow and after setting up AlteryxGallery and AlteryxService I get 405 Method Not Allowed.

Blake_E · Answer

@BonusCup this endpoint has limitations on what you have access to based on the help documentation.

Note

Only app workflows can be used.

Users are able to see jobs run by them and jobs run on schedules shared via Collections.
https://help.alteryx.com/current/en/server/api-overview/alteryx-server-api-v3/server-api-v3-objects/jobs-endpoints.html#retrieve-details-about-a-specific-job

To clarify the "schedules shared via Collections", if the schedule owner did not add the schedule within the Collection on the schedules tab, then the endpoint will not return results for you.

BonusCup · Answer

@BS_THE_ANALYST, yes.  I have a WF where I use the Server V3 API Authenticate to get my auth token and then I use [baseURL]+'admin/v1/users' to get user info and [baseURL]+'v3/workflows' to get workflowIDs.

For "users", I tried webapi/v3/users but I get error 500, { "message": "An error has occurred." }

BS_THE_ANALYST · Answer

@BonusCup, just to confirm, does any endpoint work for you?

Curious if there's something going on i.e. your account doesn't have API Access: https://help.alteryx.com/20241/en/server/administer-alteryx-server/user-and-group-management/allow-user-access-to-the-server-api.html#id602272

or if you incorrectly copied one of the api credentials https://help.alteryx.com/20241/en/server/api-overview.html?##