Cloud API Resources

Read quickstart guides and try out example API scripts.

Error Messages for Cloud APIs

baileykaplan
Moderator
Moderator
Error Code and Message Recommended Solution

HTTP 401

{
  fault: {
    faultstring: 'Invalid ApiKey',
    detail: { errorcode: 'oauth.v2.InvalidApiKey' }
  }
}

x-api-project-id header is incorrect or missing.

x-api-project-id header should have the value of an API Project ID for an API project created in the developer console.

HTTP 401

Unauthorized
Authorization: Bearer {token} header is missing or incorrect, or token is invalid. 

HTTP 404 

{
  exception: {
    name: 'RouteNotFoundException',
    message: 'This route does not exist',
    details: 'Cannot GET /iam/v1/workspaces/current'
  }
}
Request is being sent to us1.alteryxcloud.com. Check that request is being sent to api.us1.alteryxcloud.com

403 Forbidden

{
    "data" : null,
    "msg": "User \"51\" does not have create privilege on workflow"
}
This means you do not have the Platform permissions necessary to call the API. Check with your admin about giving you different permissions to complete the action.

401 Unauthorized

{
    "fault": {
        "faultstring": "Failed to resolve API Key variable request.header.x-api-project-id",
        "detail": {
            "errorcode": "steps.oauth.v2.FailedToResolveAPIKey"
        }
    }
}
This means you didn’t include an API Project ID. Make sure you get an API Project ID from the Alteryx IO Developer Console in Library.

HTTP 400 Bad Request

<html><head>
<meta http-equiv="content-type" content="text/html;charset=utf-8">
<title>400 Bad Request</title>
</head>
<body text=#000000 bgcolor=#ffffff>
<h1>Error: Bad Request</h1>
<h2>Your client has issued a malformed or illegal request.</h2>
<h2></h2>
</body></html>
You have send a GET request with a body. GET requests should not have a body.

In the API Explorer:

API Explorer Error.png

This means that the workspace you are trying to use does not work with the API Explorer yet. This might be because it requires SSO, or some other reason.

Try using a different workspace, if possible, or calling the API in Postman or through a programming language.

403 OK Error in the API Explorer

403 OK Error.png

This means you are trying to call an API that you do not have access to. You might be attempting to call an Admin API without Admin privileges.