How to get API to get information from the server

I'm trying to get data from the server using the server api tool, and I'm getting this error (see attachment). The URL I'm using the just the gallery url, and I got the key and secret key from the gallery profile as well, so I don't believe those are the issues. I have the API access permission checked under the gallery profile as well. Any help would be appreciated.

I posted this in the server discussions as well, but there hasn't been a response yet, so I thought I'd try here.

serverapierror.png

Workflow

Developer Tools

Server

API

Accepted answers

The good thing about the server api tool is that all the steps on that tutorial are not required anymore. The entire workflow is inside this connector.

I believe Postman was suggested to you because your server API tool wasn`t working and that would help understand if the issue is in the tool itself or related to access/network issues.

My guess is that the URL, key or secret had a hidden character or whitespace somewhere. Other than access and network issues, which you don`t have, I don`t see anything else that might throw those errors.

To get a list of workflows, you can use the GET /v3/workflows and the GET /v3/schedules for the list of schedules. The output can be found on the S output anchor as image below.

Screenshot 2024-10-01 141554.png

All comments

405 means you are using the wrong http action in the download tool. are you using GET? if so - try POST. If you are using POST - try GET.

@JohnLight Your base url should be the api url, not the gallery url.

It's a server setting, but by default it will be "<serveraddress>/webapi" rather than "<serveraddress>/gallery"

Try that?

Ollie

Yes, I'm doing GET. How would POST work since I'm trying to get information from the server, not post from the workflow to the server? I'm not super familiar with these APIs.

I got the same error, ran it with webapi/ and webapi without the "/." Where do I find the setting for this URL, in case it has been changed from the default for some reaso?

serverapierror.png

No - 400 is a different error. Do you see in the download tool where you have a GET? Toggle that to POST.

Most oauth2/token flows start with POST. not GET. this is a pretty standard flow. you are posting certain information to the server - it is verifying something and returning it to you. It views this as a post action. see:

https://stackoverflow.com/questions/50768635/get-or-post-for-token-generation - for example.

Oh I see, sorry for misunderstanding. I'll try it out.

Do you know what should be here? I copied parts of the URL of the collection I'm trying to get information from, but it isn't working. I'm getting the 400 error, using POST.

collectionid.png

@OllieClarke would be more knowledgeable than me about this - my memory is that collectionid isn't collection name but more of an internal identifier. you can probably find it in the URL of the server and it's probably an alphanumeric string. There's probably a way to also match collection name (display) with something internal. Are you trying to upload a workflow or run one? I'd suggest a list activity first (get all collections for example).

Yes, I just want to get the information about the schedules of the workflows that are running in the server. I tried the alphanumeric portion of the URL and got the 400 error as well.

run retrieve all collections first -> and then look at the output for the collection id.

https://help.alteryx.com/20223/en/server/api-overview/alteryx-server-api-v3/server-api-v3-objects/collection-endpoints.html#idp123119

curl --location --request GET 'http://localhost/webapi/v3/collections?view=Full' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Where do you run this? Just any command line? And where do I find the bearer token?

try going through the postman collection. order of operations should be:

1) retrieve token.

2) call collections endpoint.

if you are using a packaged macro and they don't provide it - i'd recommend going thorugh the alteryx server postman collection to:

1) see the authentication flow

2) send your token to the collection endpoint.

you should then able to replicate it in alteryx.

Postman collection is something separate from Alteryx? If I make an account, then I can follow those steps?

https://help.alteryx.com/20223/en/server/api-overview/alteryx-server-api-v3/how-to-use-postman.html#idp126511 ->

Postman is a great external api collection/testing program. we use it to build out our api logic - which we can then transfer to alteryx workflows.

Alteryx Server has a swagger -> you should be able to test collections there as well.

I followed this example here exactly, but while in the video their workflow completed with msg HTTP 200, I got HTTP/1.1 404 Not FoundContent-Length: 0Server: Microsoft-HTTPAPI/2.0

I will look at Postman and see if that can help. I've looked at the swagger page before, but haven't got it to work still.

Alteryx Server Series 2022: How to Build Gallery API (youtube.com)

community user id?

I got this error trying to use Postman

postmanerror.png

It seems like my key and secret key aren't being accepted anywhere, even though I'm getting them from the server -> my profile -> scroll down to bottom for API keys. I don't know why, but from alteryx and postman, that's what it looks like to me.

postmanerror.png

Hey @JohnLight

It might be easier to run through the full process here to get collections.

Step 1, get you api keys from your profile (not in admin)

(I'm hiding my key with the google window)

Step 2: confirm the api url by using the inbuilt swagged documentation

click on api docs in server helptake everything before //swagger

Step 3: use those keys along with the api url to login with the server api tool

Step 4: Use the /v3/collections/{collectionid} endpoint. To find the collectionId, in your browser take the alphanumeric string from the end of the collection url when in that collection

This is all based on the assumption that you have permissions to use the API. Check your permissions in your user profile

Thanks @OllieClarke - haven't used Server in a while...

Okay, I followed these exact steps, verified permissions, and am still getting this 400 error.

Hey @JohnLight - does this work in Swagger? Can you add all browse tools and see if anything is showing up? if this is working in Swagger/and you can replicate in Postman -I'd just rebuild it and dump the Alteryx prebuild tools. you can replicate exactly what you are doing in Swagger/Postman in Download tools via the multi step -> get token -> use token process.

How do I do it in Swagger? Do I use the keys for authentication? Once it's authenticated, how do I run the API?

So run this command? In the authorize section, I put the key as the Key, and secret as the Value, and I'm getting this error.

postmanerror.png

sorry - I'm sure this is frustrating. so a few things:

1) are you following this exactly?

Select Grant Type to Client Credentials.
Set Access Token URL to TOKEN_URL_FOUND_ABOVE.
Set Client ID to YOUR_API_ACCESS_KEY.
Set Client Secret to YOUR_API_ACCESS_SECRET.
Set Client Authentication to Send as Basic Auth header.
Select the Get New Access Token button.
Select Proceed.
Select the Use Token button.

see image in the middle of this page:

https://help.alteryx.com/current/en/server/api-overview/alteryx-server-api-v3/how-to-use-postman.html#UUID-1b3169a4-37b9-48f7-1758-8965e1024b2c_N1692019392129

are you spelling Client Credentials exactly as pictured?

It's not letting me import from the URL I got from swagger.

Anyone know why the Swagger URL wouldn't work in Postman?

Sorry - I could do this pretty quickly via zoom but It's hard to troubleshoot here. @fmvizcaino - any quick tips here? basic how to get collections turning into a how to sync swagger to postman conversation.

It seems everything is configured correctly. The only remaining step to check is to access your Alteryx Server System Settings and check if the API URL is correctly configured.

https://help.alteryx.com/current/en/server/api-overview/alteryx-server-api-v3/server-api-configuration-and-authorization.html#idp425511

Best,

Fernando Vizcaino

How do I get to the system settings page? Is the from the gallery or designer?

Hi @JohnLight ,

You will have to access the server machine where Alteryx Server is installed and access it from there. You can ask your server admin for this info as well.

https://help.alteryx.com/current/en/server/configure/system-settings.html

Best,

Fernando Vizcaino

I have copied the exact API URL from the settings and it still isn't working Is there a help desk? I really don't understand why nothing is accepting the exact URL provided to me by Atleryx.

support/support :: top of this page.

Does SSL need to be enabled? In the picture in the link it is, for me, it currently isn't.

Hi @JohnLight ,

Not needed.

Let me ask some questions, and I apologize if you already answered any of these before.

What happens when you try using the key and secret in Swagger? Do you get the invalid credentials error?

What is your role in the Gallery? Curator or Artisan? Asking because you have to be a curator to use the schedules endpoint.

What is the server URL you are seeing in the System Settings? Is it localhost something or the server name or IP?

Here you have the steps to use Swagger: https://knowledge.alteryx.com/index/s/article/How-to-use-the-Alteryx-Server-Web-API

Best,

Fernando Vizcaino

Hey @JohnLight is there anyone else you can ask about api authentication at your company? It looks like we have two issues here:

1) Alteryx Server (it can be a pain - it happens)

2) Api flows (they can be a pain - it happens)

The thing is --- it's much easier if someone knows how at least one of them should look. So we can't even tell if you have the right credentials/are connecting in Swagger. All of that is key. The SSL thing - that's very important - but it's specific to your server - yeah?

1. No, my credentials work, I get the blue "!" when I click authorize.

2. Where do I see my role? I have admin, but I'm not sure about curator vs artisan.

3. It's not localhost, Its http://WIN-alphanumericcombination, I'm not sure if it's the server name or not, I can ask my supervisor on Monday.

No, this is the first time my company has tried to use the server API. I am able to connect to swagger, but postman isn't working.

Hey @JohnLight ,

That is good. At least we know the API is working. Curator is Alteryx`s admin role so you are ok.

Your server name is also ok, that is the computer name.

Since you can access the server, could you please install the Server API tool inside the server`s Designer and test from there?

When you access the Gallery, are you using the same name + gallery? http://WIN-alphanumericcombination/gallery

Could you also check your Designer and Server version, please?

Best,

Fernando Vizcaino

I have the server API tool, and it is working using that. However, I tried following this tutorial (Alteryx Server Series 2022: How to Build Gallery API (youtube.com)) and it's not working.

When I access the Gallery, it is the same name + gallery.

My designer version is 2023.2.1.226 Patch: 6, the server is the same version.

Hi @JohnLight ,

I believe I misunderstood your issue then. I thought your server API tool wasn`t working at all.

This tutorial, fun fact, is from the company I used to work for and the presenter is a good friend of mine 😁

The tutorial uses a different set of APIs (old ones) and the entire workflow can be replaced by the Server API tool.

Please share the latest error you are getting and also what you are trying to accomplish now. (download workflows, view schedules, etc..)

Best,

Fernando Vizcaino

Oh understood, I will disregard those tools from that tutorial then. I just want to make sure I understand how this works because even though those tools are outdated, should they still work if I give them the correct information? I get this error from the download tool at the end of those tools: HTTP/1.1 404 Not FoundContent-Length: 0Server: Microsoft-HTTPAPI/2.0

I also want to be able to use Postman, if you think that's relevant. If it's unnecessary once I have the server API tool working, then I can let it go, but it isn't accepting the API URL to import, and I can't figure out why.

The main thing I'm trying to accomplish right now is to get information on what workflows and schedules are on the server, though I may want more information in the future. I don't know how the server tool started working, I kept putting in the same information it felt like (url, key, secret key), but somehow it just completed once, so I saved that workflow to make sure I didn't lose whatever confirmguration had worked.

The good thing about the server api tool is that all the steps on that tutorial are not required anymore. The entire workflow is inside this connector.

I believe Postman was suggested to you because your server API tool wasn`t working and that would help understand if the issue is in the tool itself or related to access/network issues.

My guess is that the URL, key or secret had a hidden character or whitespace somewhere. Other than access and network issues, which you don`t have, I don`t see anything else that might throw those errors.

To get a list of workflows, you can use the GET /v3/workflows and the GET /v3/schedules for the list of schedules. The output can be found on the S output anchor as image below.

Screenshot 2024-10-01 141554.png

Okay great, thank you and everyone else for your help and patience. I see those commands, and they are working for me.

curator_at_work

use https instead of http

Quick Links

Tags

This months top contributors

atcodedog05 19458

Qiu 15866

MarqueeCrew 13708

apathetichell 13703