Overview

Welcome to the Azuqua API 2.0!

Getting Started

This hub is meant to document all the functionality of the newest version of our API, and to serve as a starting point for developers looking to leverage Azuqua's automation programmatically.

This version of our API will also see additions in the next coming months, so be sure to check under "Announcements" on our landing page to see what's new!

Some points of interest for people getting started are the Authentication section, and information about our various clients here.

In this documentation, you'll find that each route has a couple of things:

A description of what the route does
Sample responses and errors
Generated ways to make the given request in cURL, Node, Ruby, Javascript, and Python (note, you will need to make the authorization headers on your own from these generated code snippets)
A list of parameters that can be passed in a specific request

Accessing Version 1.0

If you are looking for a route from version 1.0 of our API and don't see it, be sure to check out v1.0 documentation on this site. You can access it by clicking on the v2.0 in the upper left toolbar on this page, and selecting v1.0.

Some routes that you'll find there that will soon make it over to v2.0 are: Invoke a FLO, Resume a FLO, Retry a FLO, Generating a Open API 2.0 Spec for a FLO, Rules Engine routes, Telemetry routes.

Suggest Edits

Authentication

General

Azuqua’s API implements a signed and hashed header as its core authentication method. This method is used for every route inside of our API, with the important exception of running FLOs, which currently exist in V1. This includes FLO Invoke, Resume a FLO, Retry a FLO, and generating an Open API Spec. This allows you to set your own security setting for FLOs that are invoked via an external service- ranging from completely open, to the same secure, signed request that we require for all other routes.

To use the Azuqua API, you will need to generate a signature of the request that will be placed into a header. The Azuqua client will do this for you, but you may also generate it on your own.

Access Keys & Secrets

While using either the client or when generating the signed header by hand, you’ll need both your Access Key and Access Secret, which can be found inside the “User Settings” menu, under “Developer Settings”.

On this page, you'll see that you have an Access Key and Access Secret for each organization. This means that each resource is bound to a single organization, as opposed to a user.

Once you've grabbed the Access Key and Access Secret, if you are using the Azuqua client, you’ll be able to start making your signed, authenticated requests. If you are not using the Azuqua client, you’ll still need to generate your own signature using these values.

If you'd like to use the Azuqua client, check out "Azuqua Clients" for more information.

Generating the Signature, Step-By-Step

To generate the signed header on your own, you’ll need to follow a few steps:

Grab the correct URL path string, which starts just after the base path (https://api.azuqua.com/), including all query parameters and their values. For example: https://api.azuqua.com/org/<ID> becomes /org/<ID>
Create the base string, by joining the method name in lowercase, the URL path string from above, and the current ISO timestamp, with a colon (" : ") between each item. For example: Performing GET on the /org/<ID> route, at 9/13/17 at 3:55 PM PST becomes: get:/org/<ID>:2017-09-13T23:55:39.749Z
After this, append the stringified JSON representation of your body object, if you have one. If your body object is empty, make sure to append an empty string, not an empty object.
- Example 1: GET on the /org/<ID> route (Get Organization), at 6/6/17 at 9:02 AM PST becomes get:/org/<ID>:2017-09-13T23:55:39.749Z, since there is no body object on a GET operation.
- Example 2: PUT on the /org/<ID> (Update Organization), at 6/6/17 at 9:02 AM PST becomes put:/org/-ID-:2017-09-13T23:55:39.749Z{"name":"New Org Name","description":"New Org Description"}
Finally, sign this string by using an HMAC, SHA256 signature and your Access Secret, with a hex digest. There are many clients to complete this, even a function available while building FLOs inside of Azuqua.

Now that you’ve generated your signature, you can pass along the correct authentication headers. These will need to be added to every request. These are:

The x-api-hash header: This is the signature that we just generated above.
The x-api-accesskey header: This header will simply be the Access Key mentioned above.
The x-api-timestamp header: This is the current ISO timestamp. Azuqua uses this to confirm that the signature you created is from a recent request.
Note: Our API also depends on you specifying the "Content-Type" to be "application/json". Many clients implicitly include this, but in others you may need to specifically add this header in too. If you are using a FLO to perform this, you will need to specify this header.

If all of the above steps are completed properly, your request should be properly authenticated. If your authentication is incorrect, you may expect a 403 Unauthorized response.

Suggest Edits

Azuqua Clients

Due to Azuqua's signed security headers, you may find it significantly easier to utilize our API via our variety of clients.

We provide full clients for our API v2 in the following languages (links will take you to the github repo for each, at the appropriate branch):

We are currently operating on the apiv2 branch of each client library.

In each repo's README, you'll find information about the setup for each library and the basics of how to use them.

If you are trying to use v1.0 routes, be sure to check out the v1.0 of this page, as it will have the clients needed to perform that functionality listed there.

Suggest Edits

Rate Limiting

Rate-limiting inside of Azuqua is based on two things:

Access Key & Access Secret
Resource type. This includes items like, "FLOs", "Folders", "Accounts", "Organization", and more.

The current rate limit is set at 10 requests per second per resource for each Access Key/Secret pair.

Suggest Edits

Delete Account

Delete a given account.

deletehttps://api.azuqua.com/v2/account/account_id

curl --request DELETE \
  --url https://api.azuqua.com/v2/account/account_id

var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.azuqua.com/v2/account/account_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.azuqua.com/v2/account/account_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.azuqua.com/v2/account/account_id");

xhr.send(data);

import requests

url = "https://api.azuqua.com/v2/account/account_id"

response = requests.request("DELETE", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

to examples

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

200 OK

403 Forbidden

{ 
  "deleted": true 
}

//will occur if either you don't have access to the resource or if the resource doesn't exist
{ 
  "errors": 
   [ 
     { 
       "title" : 'Forbidden',
       "message": 'Forbidden. Refer to documentation about how to use this route'
     } 
   ] 
}

Path Params

account_id

int32

required

The ID of the account you'd like to delete.

Suggest Edits

Read Account

Read details about a given account.

gethttps://api.azuqua.com/v2/account/account_id

curl --request GET \
  --url https://api.azuqua.com/v2/account/account_id

var request = require("request");

var options = { method: 'GET',
  url: 'https://api.azuqua.com/v2/account/account_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.azuqua.com/v2/account/account_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.azuqua.com/v2/account/account_id");

xhr.send(data);

import requests

url = "https://api.azuqua.com/v2/account/account_id"

response = requests.request("GET", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

to examples

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

200 OK

404 Not Found

{ 
  "id": 301,
  "name": 'Alpha Send Grid',
  "created": '2017-07-12T19:40:17.106Z',
  "updated": '2017-07-12T19:40:17.106Z',
  "privileges": //the privileges you have on this account
   [ 
     { 
       "resource": 'CONFIG',
       "privilege": 'CHANGEROLE' 
     },
     { 
       "resource": 'CONFIG', 
       "privilege": 'SHARE' 
     },
     { 
       "resource": 'CONFIG', 
       "privilege": 'DELETE' 
     },
     { 
       "resource": 'CONFIG', 
       "privilege": 'APPLYCONFIG' 
     },
     { 
       "resource": 'CONFIG',
       "privilege": 'EXECUTE'
     },
     {
       "resource": 'CONFIG', 
       "privilege": 'EXECUTE'
     } 
   ],
  "role_type": 'CREATOR', //can be "CREATOR", "OWNER", "COLLABORATOR", "USER"
  "connector_name": 'alphasendgrid' 
}

//occurs if the connector does not exist, or you do not have access to the requested connector
{ 
  "errors": 
   [ 
     { 
       "title": 'Not Found',
       "message": 'Not Found. Check that you have access to resource'
     } 
   ] 
}

Path Params

account_id

int32

required

The ID of the account you would like to read.

Suggest Edits

Read All Accounts

Return information about all accounts you have access to in this organization.

gethttps://api.azuqua.com/v2/accounts

curl --request GET \
  --url https://api.azuqua.com/v2/accounts

var request = require("request");

var options = { method: 'GET', url: 'https://api.azuqua.com/v2/accounts' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.azuqua.com/v2/accounts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.azuqua.com/v2/accounts");

xhr.send(data);

import requests

url = "https://api.azuqua.com/v2/accounts"

response = requests.request("GET", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

to examples

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

200 OK

404 Not Found

{ 
  "data": 
   [ 
     { 
       "id": 123, 
    	 "name": 'JIRA',
    	 "created": '2017-07-12T19:31:05.025Z',
       "updated": '2017-07-12T19:31:05.025Z',
       "privileges": [ [Object], [Object], [Object], [Object], [Object], [Object] ],
       "role_type": 'CREATOR', //can be either 'USER', 'OWNER' and 'CREATOR'
       "connector_name": 'jira2' 
     }
   ]
}

//Occurs when you do not have access to any accounts in your organization
{ 
  "errors": 
   [ 
     { 
       "title": 'Not Found',
       "message": 'Not Found. Check that you have access to resource'
     } 
   ] 
}

Suggest Edits

Update Account Permissions for User

Update the access level a given user will have on a given on an account.

puthttps://api.azuqua.com/v2/account/account_id/user/user_id/permissions

curl --request PUT \
  --url https://api.azuqua.com/v2/account/account_id/user/user_id/permissions

var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.azuqua.com/v2/account/account_id/user/user_id/permissions' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.azuqua.com/v2/account/account_id/user/user_id/permissions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.azuqua.com/v2/account/account_id/user/user_id/permissions");

xhr.send(data);

import requests

url = "https://api.azuqua.com/v2/account/account_id/user/user_id/permissions"

response = requests.request("PUT", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

to examples

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

200 OK

400 Bad Request

403 Forbidden

{ "changed": true }

//Occurs if you pass in an invalid value as the "role" parameter 
{ 
  "errors": 
   [ 
     { 
       "title": 'Bad Request',
       "message": 'Error at parameter role: No enum match for: "INVALID_NAME_HERE"' 
     } 
   ] 
}

//occurs if you do not have access to either the account or user, or if either of those resources do not exist
{
  "errors": 
   [ 
     { 
       "title": 'Forbidden',
       "message": 'Forbidden. Refer to documentation about how to use this route' 
     } 
   ] 
}

Path Params

account_id

int32

required

The ID of the account you'd like to update permissions on

user_id

int32

required

The ID of the user you would like to update permissions on

Body Params

role

string

required

The role you would like to promote/demote the given user to on the given account. May be "NONE", "RUN", "USE", "EDIT".

Suggest Edits

Read Connector By Version

Read information about a connector at a given version.

gethttps://api.azuqua.com/v2/connectors/connector_name/connector_version

curl --request GET \
  --url https://api.azuqua.com/v2/connectors/connector_name/connector_version

var request = require("request");

var options = { method: 'GET',
  url: 'https://api.azuqua.com/v2/connectors/connector_name/connector_version' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.azuqua.com/v2/connectors/connector_name/connector_version")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.azuqua.com/v2/connectors/connector_name/connector_version");

xhr.send(data);

import requests

url = "https://api.azuqua.com/v2/connectors/connector_name/connector_version"

response = requests.request("GET", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

to examples

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

200 OK

404 Not Found

{ 
  "id": 499,
  "name": 'gameofflosalpha',
  "methods": 
   [ 
     { 
       "type": 'action', //can also be 'metadata' or 'event'
       "name": 'getCharacter',
       "displayName": 'Get Character',
       "description": 'This is my description.' 
     }
   ]
}

//occurs if a given connector or a requested version does not exist, or you do not have permission to that connector
{ 
  errors: 
   [ 
     { 
       title: 'Not Found',
       message: 'Not Found. Check that you have access to resource' 
     } 
   ] 
}

Path Params

connector_name

string

required

The name of the id name of a connector (the non-capitalized name that appears in connector builder, or on the "method name" option on a card's settings page.

connector_version

string

required

The version number you'd like to read information from.

Suggest Edits

Copy FLO

Copy a FLO into a provided folder. If the folder is not provided, this route will copy the FLO into the same folder as the original FLO.

posthttps://api.azuqua.com/v2/flo/flo_id/copy

curl --request POST \
  --url https://api.azuqua.com/v2/flo/flo_id/copy

var request = require("request");

var options = { method: 'POST',
  url: 'https://api.azuqua.com/v2/flo/flo_id/copy' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.azuqua.com/v2/flo/flo_id/copy")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.azuqua.com/v2/flo/flo_id/copy");

xhr.send(data);

import requests

url = "https://api.azuqua.com/v2/flo/flo_id/copy"

response = requests.request("POST", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

to examples

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

200 OK

404 Not Found

{ 
  "copied": true, 
  "id": 1795 
}

//Occurs if the flo or folder do not exist, or if you do not have access to them
{
  "errors": 
   [ 
     { 
       "title": 'Forbidden',
       "message": 'Forbidden. Refer to documentation about how to use this route' 
     } 
   ] 
}

Path Params

flo_id

int32

required

The ID of the FLO you would like to copy

Body Params

folder_id

int32

(Optional) The ID of the folder you'd like the new FLO to be moved to. If not provided, will make a copy FLO in the same folder as its source FLO.

Suggest Edits

Copy FLO into Organization

Copy a FLO into a provided organization, while optionally copying it into a specified folder.

posthttps://api.azuqua.com/v2/flo/flo_id/copy/org/org_id

curl --request POST \
  --url https://api.azuqua.com/v2/flo/flo_id/copy/org/org_id

var request = require("request");

var options = { method: 'POST',
  url: 'https://api.azuqua.com/v2/flo/flo_id/copy/org/org_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.azuqua.com/v2/flo/flo_id/copy/org/org_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.azuqua.com/v2/flo/flo_id/copy/org/org_id");

xhr.send(data);

import requests

url = "https://api.azuqua.com/v2/flo/flo_id/copy/org/org_id"

response = requests.request("POST", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

to examples

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

200 OK

404 Not Found

{
  "copied": true,
  "id": 123 
}

//Occurs if you don't have access to the org, flo, or folder, or they don't exist
{ 
  "errors": 
   [ 
     { 
       "title": 'Not Found',
       "message": 'Not Found. Check that you have access to resource'
     } 
   ]
}

Path Params

flo_id

int32

required

The ID of the FLO you would like to make a copy of, to send to another org.

org_id

int32

required

The ID of the organization you would like to copy the FLO into. You must have permission to access the target organization.

Body Params

folder_id

int32

(Optional) The ID of the folder you would like to copy the FLO into in the destination organization. If not provided, will copy into "My FLOs" tab in destination organization

Suggest Edits

Delete FLO

Delete a FLO with a given ID.

deletehttps://api.azuqua.com/v2/flo/flo_id

curl --request DELETE \
  --url https://api.azuqua.com/v2/flo/flo_id

var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.azuqua.com/v2/flo/flo_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.azuqua.com/v2/flo/flo_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.azuqua.com/v2/flo/flo_id");

xhr.send(data);

import requests

url = "https://api.azuqua.com/v2/flo/flo_id"

response = requests.request("DELETE", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

to examples

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

200 OK

403 Forbidden

{ "deleted": true }

//Occurs if you either can't access the FLO, or if the FLO does not exist.
{
  "errors": 
   [ 
     { 
       "title": 'Forbidden',
       "message": 'Forbidden. Refer to documentation about how to use this route' 
     } 
   ] 
}

Path Params

flo_id

int32

required

The ID of the FLO you'd like to delete.

Suggest Edits

Disable FLO

Disable, or "Turn Off", a given FLO.

puthttps://api.azuqua.com/v2/flo/flo_id/disable

curl --request PUT \
  --url https://api.azuqua.com/v2/flo/flo_id/disable

var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.azuqua.com/v2/flo/flo_id/disable' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.azuqua.com/v2/flo/flo_id/disable")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.azuqua.com/v2/flo/flo_id/disable");

xhr.send(data);

import requests

url = "https://api.azuqua.com/v2/flo/flo_id/disable"

response = requests.request("PUT", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

to examples

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

200 OK

404 Not Found

{ "disabled": true }

//Occurs if the given FLO does not exist or if you do not have access to it
{ 
  "errors": 
   [ 
     { 
       "title": 'Not Found',
       "message": 'Not Found. Check that you have access to resource'
     } 
   ] 
}

Path Params

flo_id

int32

required

The ID of the FLO you would like to disable, or "turn off".

Suggest Edits

Enable FLO

Enable, or "Turn On", a given FLO.

puthttps://api.azuqua.com/v2/flo/flo_id/enable

curl --request PUT \
  --url https://api.azuqua.com/v2/flo/flo_id/enable

var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.azuqua.com/v2/flo/flo_id/enable' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.azuqua.com/v2/flo/flo_id/enable")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.azuqua.com/v2/flo/flo_id/enable");

xhr.send(data);

import requests

url = "https://api.azuqua.com/v2/flo/flo_id/enable"

response = requests.request("PUT", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

to examples

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

200 OK

404 Not Found

{ "enabled": true }

//Occurs if the FLO does not exist or you do not have access to it
{ 
  "errors": 
   [ 
     { 
       "title": 'Not Found',
       "message": 'Not Found. Check that you have access to resource' 
     } 
   ] 
}

Path Params

flo_id

int32

required

The ID of the FLO you would like to enable, or "turn on".

Suggest Edits

Move FLO to Folder

Move a FLO into another folder.

puthttps://api.azuqua.com/v2/flo/flo_id/move/folder/folder_id

curl --request PUT \
  --url https://api.azuqua.com/v2/flo/flo_id/move/folder/folder_id

var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.azuqua.com/v2/flo/flo_id/move/folder/folder_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.azuqua.com/v2/flo/flo_id/move/folder/folder_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.azuqua.com/v2/flo/flo_id/move/folder/folder_id");

xhr.send(data);

import requests

url = "https://api.azuqua.com/v2/flo/flo_id/move/folder/folder_id"

response = requests.request("PUT", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

to examples

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

200 OK

403 Forbidden

{ "moved": true }

//Occurs if the FLO or folder doesn't exist, or if you do not have access to it
{
  "errors": 
   [ 
     { 
       "title": 'Forbidden',
       "message": 'Forbidden. Refer to documentation about how to use this route' 
     } 
   ] 
}

Path Params

flo_id

int32

required

The ID of the FLO you would like to move.

folder_id

int32

required

The ID of the folder you'd like to move the FLO into.

Suggest Edits

Read Accounts for FLO

Get all accounts associated to a FLO.

gethttps://api.azuqua.com/v2/flo/flo_id/accounts

curl --request GET \
  --url https://api.azuqua.com/v2/flo/flo_id/accounts

var request = require("request");

var options = { method: 'GET',
  url: 'https://api.azuqua.com/v2/flo/flo_id/accounts' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.azuqua.com/v2/flo/flo_id/accounts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.azuqua.com/v2/flo/flo_id/accounts");

xhr.send(data);

import requests

url = "https://api.azuqua.com/v2/flo/flo_id/accounts"

response = requests.request("GET", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

to examples

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

200 OK

404 Not Found

[ 
  { 
    "id": 123,
    "name": 'account_name',
    "created": '2017-02-02T22:49:49.439Z',
    "updated": '2017-05-10T18:17:06.517Z',
    "role_type": 'USER',
    "privileges": [ [Object], [Object] ],
    "connector_name": 'connector_name' 
  } 
]

//Occurs if the FLO does not exist, you do not have permission to view it, or there are no accounts associated to a FLO
{ 
  "errors": 
   [ 
     { 
       "title": 'Not Found',
       "message": 'Not Found. Check that you have access to resource'
     }
   ]
}

Path Params

flo_id

int32

required

The ID of the FLO.

Suggest Edits

Read All FLOs

Get a list of all the FLOs inside of your organization.

gethttps://api.azuqua.com/v2/org/flos

curl --request GET \
  --url https://api.azuqua.com/v2/org/flos

var request = require("request");

var options = { method: 'GET', url: 'https://api.azuqua.com/v2/org/flos' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.azuqua.com/v2/org/flos")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.azuqua.com/v2/org/flos");

xhr.send(data);

import requests

url = "https://api.azuqua.com/v2/org/flos"

response = requests.request("GET", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

to examples

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

200 OK

404 Not Found

[ 
  { 
    "id": 123,
    "alias": 'this_is_my_alias',
    "name": 'Test with Event',
    "active": false,
    "published": false,
    "security_level": null,
    "client_token": 'this_is_this_flos_client_token',
    "description": '',
    "updated": '2017-07-31T17:00:53.624Z',
    "created": '2017-07-31T16:35:48.624Z',
    "type": null,
    "role_type": 'CREATOR',
    "privileges": 
     [ 
       [Object],
       [Object],
       [Object],
       [Object],
       [Object],
       [Object],
       [Object],
       [Object],
       [Object],
       [Object],
       [Object],
       [Object] 
     ] 
  }
 ]

//Occurs if you have no FLOs in your organization
{ 
  "errors": 
   [ 
     { 
       "title": 'Not Found',
       "message": 'Not Found. Check that you have access to resource'
     } 
   ] 
}

Suggest Edits

Read FLO

Reads metadata about a FLO.

gethttps://api.azuqua.com/v2/flo/flo_id

curl --request GET \
  --url https://api.azuqua.com/v2/flo/flo_id

var request = require("request");

var options = { method: 'GET',
  url: 'https://api.azuqua.com/v2/flo/flo_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.azuqua.com/v2/flo/flo_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.azuqua.com/v2/flo/flo_id");

xhr.send(data);

import requests

url = "https://api.azuqua.com/v2/flo/flo_id"

response = requests.request("GET", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

to examples

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

200 OK

404 Not Found

{ 
  "id": 1234,
  "alias": 'this_is_my_alias',
  "name": 'Test with Event',
  "type": null,
  "active": false,
  "published": false,
  "security_level": null,
  "client_token": 'this_is_the_client_token_for_the_flo',
  "description": '',
  "created": '2017-07-31T16:35:48.624Z',
  "updated": '2017-07-31T17:00:53.624Z',
  "privileges": 
   [ { "resource": 'FLO', "privilege": 'CHANGEROLE' },
     { "resource": 'FLO', "privilege": 'WRITE' },
     { "resource": 'FLO', "privilege": 'READDATA' },
     { "resource": 'FLO', "privilege": 'ADD' },
     { "resource": 'FLO', "privilege": 'REMOVE' },
     { "resource": 'FLO', "privilege": 'DUPLICATE' },
     { "resource": 'FLO', "privilege": 'SHARE' },
     { "resource": 'FLO', "privilege": 'DELETE' },
     { "resource": 'FLO', "privilege": 'MOVE' },
     { "resource": 'FLO', "privilege": 'READ' },
     { "resource": 'FLO', "privilege": 'LIST' },
     { "resource": 'FLO', "privilege": 'EXECUTE' } 
   ],
  "role_type": 'CREATOR' 
}

//Occurs if the FLO does not exist, or you do not have access to it
{ 
  "errors": 
   [ 
     { 
       "title": 'Not Found',
       "message": 'Not Found. Check that you have access to resource' 
     } 
   ] 
}

Path Params

flo_id

int32

required

The ID of the FLO you would like to read.

Suggest Edits

Read FLO Inputs

Grab a list of the inputs of a given FLO.

gethttps://api.azuqua.com/v2/flo/flo_id/inputs

curl --request GET \
  --url https://api.azuqua.com/v2/flo/flo_id/inputs

var request = require("request");

var options = { method: 'GET',
  url: 'https://api.azuqua.com/v2/flo/flo_id/inputs' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.azuqua.com/v2/flo/flo_id/inputs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.azuqua.com/v2/flo/flo_id/inputs");

xhr.send(data);

import requests

url = "https://api.azuqua.com/v2/flo/flo_id/inputs"

response = requests.request("GET", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

to examples

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

200 OK

404 Not Found

[ 
  { 
    "key": 'headers',
    "defaultValue": {},
    "group": 'raw',
    "collection": false,
    "type": 'object',
    "metadata": { 
      "hidden": true, 
      "index": 0, 
      "typeLocked": true 
    } 
  },
  { 
    "key": 'body',
    "defaultValue": '',
    "group": 'raw',
    "collection": false,
    "type": 'string',
    "metadata": { 
      "hidden": true, 
      "index": 1 
    } 
  },
  { 
    "key": 'query',
    "defaultValue": '',
    "group": 'raw',
    "collection": false,
    "type": 'string',
    "metadata": { 
      "hidden": true, 
      "index": 2 
    } 
  },
  { 
    "key": 'Body Item 1',
    "defaultValue": '',
    "group": 'body',
    "collection": false,
    "type": 'string',
    "metadata": { 
      "index": 4, 
      "custom": true 
    } 
  },
  { 
    "key": 'Header 1',
    "defaultValue": '',
    "group": 'headers',
    "collection": false,
    "type": 'string',
    "metadata": { 
      "index": 5, 
      "custom": true 
    } 
  },
  { 
    "key": 'Query 1',
    "defaultValue": '',
    "group": 'query',
    "collection": false,
    "type": 'string',
    "metadata": { 
      "index": 6, 
      "custom": true 
    } 
  } 
]

//Occurs if you do not have access to the given FLO, or if it does not exist
{ 
  "errors": 
   [ 
     { 
       "title": 'Not Found',
       "message": 'Not Found. Check that you have access to resource' 
     } 
   ] 
}

Path Params

flo_id

int32

required

The ID of the FLO you would like to grab inputs from.

Suggest Edits

Update FLO Metadata

Update the metadata (name & decription) of a FLO

puthttps://api.azuqua.com/v2/flo/flo_id

curl --request PUT \
  --url https://api.azuqua.com/v2/flo/flo_id

var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.azuqua.com/v2/flo/flo_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.azuqua.com/v2/flo/flo_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.azuqua.com/v2/flo/flo_id");

xhr.send(data);

import requests

url = "https://api.azuqua.com/v2/flo/flo_id"

response = requests.request("PUT", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

to examples

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

200 OK

403 Forbidden

{ "updated": true }

//Occurs if the FLO doesn't exist or you do not have access to it.
{
  "errors": 
   [ 
     { 
       "title": 'Forbidden',
       "message": 'Forbidden. Refer to documentation about how to use this route' 
     } 
   ] 
}

Path Params

flo_id

int32

required

The ID of the FLO you'd like to upate

Body Params

name

string

The name of the FLO.

description

string

The description of the FLO.

Suggest Edits

Create Folder

Create a folder in your organization with a given name and description.

posthttps://api.azuqua.com/v2/folder

curl --request POST \
  --url https://api.azuqua.com/v2/folder

var request = require("request");

var options = { method: 'POST', url: 'https://api.azuqua.com/v2/folder' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.azuqua.com/v2/folder")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.azuqua.com/v2/folder");

xhr.send(data);

import requests

url = "https://api.azuqua.com/v2/folder"

response = requests.request("POST", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

to examples

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

200 OK

{ "id": 123 }

Body Params

name

string

The name of the new folder.

description

string

The description of the new folder.

Suggest Edits

Delete Folder

Delete a given folder.

deletehttps://api.azuqua.com/v2/folder/folder_id

curl --request DELETE \
  --url https://api.azuqua.com/v2/folder/folder_id

var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.azuqua.com/v2/folder/folder_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.azuqua.com/v2/folder/folder_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.azuqua.com/v2/folder/folder_id");

xhr.send(data);

import requests

url = "https://api.azuqua.com/v2/folder/folder_id"

response = requests.request("DELETE", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

to examples

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

200 OK

403 Forbidden

{ "deleted": true }

//Occurs if you do not have access to the given folder, or it does not exist
{
  "errors": 
   [ 
     { 
       "title": 'Forbidden',
       "message": 'Forbidden. Refer to documentation about how to use this route' 
     } 
   ] 
}

Path Params

folder_id

int32

required

The ID of the folder you'd like to delete.

Suggest Edits

Read All Folders

Read all folders in your organization.

gethttps://api.azuqua.com/v2/folders

curl --request GET \
  --url https://api.azuqua.com/v2/folders

var request = require("request");

var options = { method: 'GET', url: 'https://api.azuqua.com/v2/folders' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.azuqua.com/v2/folders")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.azuqua.com/v2/folders");

xhr.send(data);

import requests

url = "https://api.azuqua.com/v2/folders"

response = requests.request("GET", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

to examples

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

200 OK

[ 
  { 
    "id": 123,
    "org_id": 1,
    "name": 'My Folder',
    "description": '',
    "role_type": 'USER' 
  },
  { 
    "id": 456,
    "org_id": 1,
    "name": 'Shared Folder',
    "description": 'Cool group',
    "role_type": 'COLLABORATOR' 
  }
]

Suggest Edits

Read FLOs in Folder

Read all FLOs inside of a given folder.

gethttps://api.azuqua.com/v2/folder/folder_id/flos

curl --request GET \
  --url https://api.azuqua.com/v2/folder/folder_id/flos

var request = require("request");

var options = { method: 'GET',
  url: 'https://api.azuqua.com/v2/folder/folder_id/flos' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.azuqua.com/v2/folder/folder_id/flos")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.azuqua.com/v2/folder/folder_id/flos");

xhr.send(data);

import requests

url = "https://api.azuqua.com/v2/folder/folder_id/flos"

response = requests.request("GET", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

to examples

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

200 OK

404 Not Found

[ 
  { 
    "id": 123,
    "alias": 'abcdefghijklmnopqrstuv',
    "name": 'Test with Event',
    "type": null,
    "active": false,
    "published": false,
    "security_level": null,
    "client_token": 'clientTokenOfMyFlo',
    "description": '',
    "created": '2017-07-31T16:35:48.624Z',
    "updated": '2017-07-31T17:00:53.624Z',
    "role_type": 'CREATOR' 
  } 
]

//Occurs if the folder does not exist, or if there are no flos in the folder
{ 
  "errors": 
   [ 
     { 
       "title": 'Not Found',
       "message": 'Not Found. Check that you have access to resource' 
     } 
   ] 
}

Path Params

folder_id

int32

required

The ID of the folder you'd like read FLOs from.

Suggest Edits

Read Folder

Read the metadata about a given folder.

gethttps://api.azuqua.com/v2/folder/folder_id

curl --request GET \
  --url https://api.azuqua.com/v2/folder/folder_id

var request = require("request");

var options = { method: 'GET',
  url: 'https://api.azuqua.com/v2/folder/folder_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.azuqua.com/v2/folder/folder_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.azuqua.com/v2/folder/folder_id");

xhr.send(data);

import requests

url = "https://api.azuqua.com/v2/folder/folder_id"

response = requests.request("GET", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

to examples

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

200 OK

404 Not Found

{ 
  "id": 123,
  "org_id": 123,
  "user_id": 123,
  "name": 'Shared Folder',
  "description": 'This is my description',
  "privileges": 
   [ { "resource": 'GROUP', "privilege": 'ADD' },
     { "resource": 'GROUP', "privilege": 'WRITE' },
     { "resource": 'GROUP', "privilege": 'REMOVE' },
     { "resource": 'GROUP', "privilege": 'DELETE' },
     { "resource": 'GROUP', "privilege": 'READ' },
     { "resource": 'GROUP', "privilege": 'CREATEGROUPMESSAGE' },
     { "resource": 'GROUP', "privilege": 'LIST' },
     { "resource": 'FLO', "privilege": 'CHANGEROLE' },
     { "resource": 'FLO', "privilege": 'WRITE' },
     { "resource": 'FLO', "privilege": 'READDATA' },
     { "resource": 'FLO', "privilege": 'ADD' },
     { "resource": 'FLO', "privilege": 'REMOVE' },
     { "resource": 'FLO', "privilege": 'DUPLICATE' },
     { "resource": 'FLO', "privilege": 'SHARE' },
     { "resource": 'FLO', "privilege": 'DELETE' },
     { "resource": 'FLO', "privilege": 'MOVE' },
     { "resource": 'FLO', "privilege": 'READ' },
     { "resource": 'FLO', "privilege": 'LIST' },
     { "resource": 'FLO', "privilege": 'EXECUTE' } ],
  "role_type": 'OWNER' 
}

//Occurs when you either don't have access to the folder, or the folder does not exist
{ 
  "errors": 
   [ 
     { 
       "title": 'Not Found',
       "message": 'Not Found. Check that you have access to resource' 
     } 
   ] 
}

Path Params

folder_id

int32

required

The ID of the folder you'd like to read from.

Suggest Edits

Read Folder Users

Read all the users that have access to a folder.

gethttps://api.azuqua.com/v2/folder/folder_id/users

curl --request GET \
  --url https://api.azuqua.com/v2/folder/folder_id/users

var request = require("request");

var options = { method: 'GET',
  url: 'https://api.azuqua.com/v2/folder/folder_id/users' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.azuqua.com/v2/folder/folder_id/users")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.azuqua.com/v2/folder/folder_id/users");

xhr.send(data);

import requests

url = "https://api.azuqua.com/v2/folder/folder_id/users"

response = requests.request("GET", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

to examples

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

200 OK

404 Not Found

[ 
  {
    "id": 123,
    "email": '-@email.com',
    "company": 'Azuqua',
    "first_name": 'First Name',
    "last_name": 'Last Name'
  } 
]

//Occurs when the folder does not exist or when you do not have access to the folder
{ 
  "errors": 
   [ 
     { 
       "title": 'Not Found',
       "message": 'Not Found. Check that you have access to resource' 
     }
   ]
}

Path Params

folder_id

int32

required

The ID of the folder you would like to read users from.

Suggest Edits

Update Folder

Update metadata about a folder (name, description).

puthttps://api.azuqua.com/v2/folder/folder_id

curl --request PUT \
  --url https://api.azuqua.com/v2/folder/folder_id

var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.azuqua.com/v2/folder/folder_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.azuqua.com/v2/folder/folder_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.azuqua.com/v2/folder/folder_id");

xhr.send(data);

import requests

url = "https://api.azuqua.com/v2/folder/folder_id"

response = requests.request("PUT", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

to examples

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

200 OK

403 Forbidden

//This will return the information changed back to you. In this case, the user changed both the name and description
{ 
  "name": 'THIS IS NEW', 
  "description": 'I, TOO, AM NEW' 
}

//Occurs when the folder doesn't exist, or you don't have access to the folder
{
  "errors": 
   [ 
     { 
       "title": 'Forbidden',
       "message": 'Forbidden. Refer to documentation about how to use this route' 
     } 
   ] 
}

Path Params

folder_id

int32

required

The ID of the folder you'd like to update.

Body Params

name

string

The name that will replace your folder's existing name.

description

string

The description that will replace your folder's current description.

Suggest Edits

Update User Permissions to Folder

Update the permissions a user has a on a given folder.

puthttps://api.azuqua.com/v2/folder/folder_id/user/user_id/permissions

curl --request PUT \
  --url https://api.azuqua.com/v2/folder/folder_id/user/user_id/permissions

var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.azuqua.com/v2/folder/folder_id/user/user_id/permissions' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.azuqua.com/v2/folder/folder_id/user/user_id/permissions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.azuqua.com/v2/folder/folder_id/user/user_id/permissions");

xhr.send(data);

import requests

url = "https://api.azuqua.com/v2/folder/folder_id/user/user_id/permissions"

response = requests.request("PUT", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

to examples

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

200 OK

404 Not Found

400 Bad Request

{ "changed": true }

//Occurs if the folder or user doesn't exist
{ 
  "errors": 
   [ 
     { 
       "title": 'Not Found',
       "message": 'Not Found. Check that you have access to resource' 
     }
   ]
}

//Occurs if you pass in an invalid value as the "role" parameter 
{ 
  "errors": 
   [ 
     { 
       "title": 'Bad Request',
       "message": 'Error at parameter role: No enum match for: "INVALID_NAME_HERE"' 
     } 
   ] 
}

Path Params

folder_id

int32

required

The ID of the folder you'd like to adjust user permissions to.

user_id

int32

required

The ID of the user whose permissions you'd like to adjust on this folder.

Body Params

role

string

required

The role you'd like to change your user to. Can be "NONE", "RUN", "USE", "EDIT".

Suggest Edits

Read Organization

Read information about your organization.

gethttps://api.azuqua.com/v2/org

curl --request GET \
  --url https://api.azuqua.com/v2/org

var request = require("request");

var options = { method: 'GET', url: 'https://api.azuqua.com/v2/org' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.azuqua.com/v2/org")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.azuqua.com/v2/org");

xhr.send(data);

import requests

url = "https://api.azuqua.com/v2/org"

response = requests.request("GET", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

to examples

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

200 OK

{ 
  "id": 123,
  "name": 'My Test Org',
  "display_name": 'Test Org',
  "active": true,
  "created": '2017-03-28T20:57:08.624Z',
  "updated": '2017-07-28T21:38:28.451Z',
  "flos_migrated": true,
  "publisher": 'PUBLISHER_ORG_50',
  "privileges": 
   [ 
     { "resource": 'USER', "privilege": 'ADD' },
     { "resource": 'USER', "privilege": 'REMOVE' },
     { "resource": 'USER', "privilege": 'CHANGEROLE' },
     { "resource": 'USER', "privilege": 'CHANGEORGROLE' },
     { "resource": 'USER', "privilege": 'READ' },
     { "resource": 'ORG', "privilege": 'READ' },
     { "resource": 'FLO', "privilege": 'CREATE' },
     { "resource": 'CONFIG', "privilege": 'CREATE' } 
   ],
  "role_type": 'BILLINGADMIN' 
}

Suggest Edits

Update Org

Update metadata about your organization (name, description).

puthttps://api.azuqua.com/v2/org

curl --request PUT \
  --url https://api.azuqua.com/v2/org

var request = require("request");

var options = { method: 'PUT', url: 'https://api.azuqua.com/v2/org' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.azuqua.com/v2/org")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.azuqua.com/v2/org");

xhr.send(data);

import requests

url = "https://api.azuqua.com/v2/org"

response = requests.request("PUT", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

to examples

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

200 OK

//This will respond back with the field that was updated. In this case, only the name was updated.
{ 
  "name": 'MY NEW NAME'
}

Body Params

name

string

The name that will replace your organization's current name.

description

string

The description that will replace your organization's existing description.

Suggest Edits

Read User Orgs

Get all the orgs that you belong to.

gethttps://api.azuqua.com/v2/user/orgs

curl --request GET \
  --url https://api.azuqua.com/v2/user/orgs

var request = require("request");

var options = { method: 'GET', url: 'https://api.azuqua.com/v2/user/orgs' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.azuqua.com/v2/user/orgs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.azuqua.com/v2/user/orgs");

xhr.send(data);

import requests

url = "https://api.azuqua.com/v2/user/orgs"

response = requests.request("GET", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

to examples

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

200 OK

[ 
  { 
    "id": 123,
    "name": 'My Org',
    "display_name": 'My Org (Display)',
    "plan": '123',
    "active": true,
    "created": '2017-01-31T20:38:15.979Z',
    "updated": '2017-07-31T22:55:05.274Z',
    "role_type": 'ADMIN',
    "privileges": 
    [ 
      [Object], 
      [Object], 
      [Object], 
      [Object], 
      [Object], 
      [Object] 
    ] 
  }
]

Suggest Edits

Update User Role in Organization

Update a user's role (billing admin, admin, member) inside your organization. Note, you may not update someone away from being billing admin.

puthttps://api.azuqua.com/v2/org/user/user_id/permissions

curl --request PUT \
  --url https://api.azuqua.com/v2/org/user/user_id/permissions

var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.azuqua.com/v2/org/user/user_id/permissions' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.azuqua.com/v2/org/user/user_id/permissions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.azuqua.com/v2/org/user/user_id/permissions");

xhr.send(data);

import requests

url = "https://api.azuqua.com/v2/org/user/user_id/permissions"

response = requests.request("PUT", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

to examples

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

200 OK

404 Not Found

400 Bad Request

{ "changed": true }

//Occurs when the user doesn't exist
{
  "errors": 
   [ 
     { 
       "title": 'Not Found',
       "message": 'Not Found. Check that you have access to resource'
     } 
   ]
}

//Occurs if you pass in an invalid value as the "role" parameter 
{ 
  "errors": 
   [ 
     { 
       "title": 'Bad Request',
       "message": 'Error at parameter role: No enum match for: "INVALID_NAME_HERE"' 
     } 
   ] 
}

Path Params

user_id

int32

required

The ID of the user whose role you would like to change.

Body Params

role

string

required

The role you would like to update the user to. Can be either "BILLING ADMIN", "ADMIN", or "MEMBER".